Company logoTrust Center Documentation

Create a new contact

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

POST
/api/v1/contacts

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

email*string

Valid email address

Formatemail
first_name*string

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

application/json

application/json

curl -X POST "https://app.orbiqhq.com/api/v1/contacts" \  -H "Content-Type: application/json" \  -d '{    "email": "john.doe@example.com",    "first_name": "John",    "last_name": "Doe",    "title": "Security Manager",    "review_status": "to_review"  }'
{
  "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
Empty

How is this guide?