The Contact object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

first_name string
middle_name string
last_name string
full_name string
email_id string
phone string
mobile_no string
gender string
salutation string
image string
status string

Default: Passive

company_name string
designation string
department string
user string
address string
is_primary_contact boolean

Default: false

unsubscribed boolean

Default: false

The Contact object 
{
  "id": "contact_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "email_id": "user@example.com",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "gender": "gender_example",
  "salutation": "salutation_example",
  "image": "image_example",
  "status": "Passive",
  "company_name": "Example Corp",
  "designation": "designation_example",
  "department": "department_example",
  "user": "user_example",
  "address": "address_example",
  "is_primary_contact": false,
  "unsubscribed": false
}
GET /api/core/contact/{id}

Retrieve a contact

Retrieves the details of an existing contact. Supply the unique contact ID that was returned from a previous request.

Path parameters

id string required

The identifier of the contact to retrieve.

Returns

Returns the contact object if a valid identifier was provided.

GET /api/core/contact/{id} 
curl https://api.overplane.dev/api/core/contact/contact_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "contact_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "email_id": "user@example.com",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "gender": "gender_example",
  "salutation": "salutation_example",
  "image": "image_example",
  "status": "Passive",
  "company_name": "Example Corp",
  "designation": "designation_example",
  "department": "department_example",
  "user": "user_example",
  "address": "address_example",
  "is_primary_contact": false,
  "unsubscribed": false
}
GET /api/core/contact

List all contacts

Returns a list of contacts. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of contact objects.

GET /api/core/contact 
curl https://api.overplane.dev/api/core/contact \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "contact_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "first_name": "first_name_example",
      "middle_name": "middle_name_example",
      "last_name": "last_name_example",
      "full_name": "full_name_example",
      "email_id": "user@example.com",
      "phone": "phone_example",
      "mobile_no": "mobile_no_example",
      "gender": "gender_example",
      "salutation": "salutation_example",
      "image": "image_example",
      "status": "Passive",
      "company_name": "Example Corp",
      "designation": "designation_example",
      "department": "department_example",
      "user": "user_example",
      "address": "address_example",
      "is_primary_contact": false,
      "unsubscribed": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/core/contact

Create a contact

Creates a new contact object.

Body parameters

first_name string
middle_name string
last_name string
full_name string
email_id string
phone string
mobile_no string
gender string
salutation string
image string
status string

Default: Passive

company_name string
designation string
department string
user string
address string
is_primary_contact boolean

Default: false

unsubscribed boolean

Default: false

Returns

Returns the newly created contact object if the call succeeded.

POST /api/core/contact 
curl https://api.overplane.dev/api/core/contact \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "contact_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "email_id": "user@example.com",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "gender": "gender_example",
  "salutation": "salutation_example",
  "image": "image_example",
  "status": "Passive",
  "company_name": "Example Corp",
  "designation": "designation_example",
  "department": "department_example",
  "user": "user_example",
  "address": "address_example",
  "is_primary_contact": false,
  "unsubscribed": false
}
PATCH /api/core/contact/{id}

Update a contact

Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the contact to update.

Body parameters

first_name string
middle_name string
last_name string
full_name string
email_id string
phone string
mobile_no string
gender string
salutation string
image string
status string

Default: Passive

company_name string
designation string
department string
user string
address string
is_primary_contact boolean

Default: false

unsubscribed boolean

Default: false

Returns

Returns the updated contact object.

PATCH /api/core/contact/{id} 
curl https://api.overplane.dev/api/core/contact/contact_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"first_name":"first_name_example","middle_name":"middle_name_example"}'
Response 
{
  "id": "contact_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "email_id": "user@example.com",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "gender": "gender_example",
  "salutation": "salutation_example",
  "image": "image_example",
  "status": "Passive",
  "company_name": "Example Corp",
  "designation": "designation_example",
  "department": "department_example",
  "user": "user_example",
  "address": "address_example",
  "is_primary_contact": false,
  "unsubscribed": false
}
DELETE /api/core/contact/{id}

Delete a contact

Permanently deletes a contact. This cannot be undone.

Path parameters

id string required

The identifier of the contact to delete.

Returns

Returns a confirmation that the contact has been deleted.

DELETE /api/core/contact/{id} 
curl https://api.overplane.dev/api/core/contact/contact_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "contact_abc123",
  "deleted": true
}