---
title: "Create Contact"
method: POST
path: "/v1/workspaces/{workspace_id}/contacts"
tags: ["Contacts"]
---

# Create Contact

`POST /v1/workspaces/{workspace_id}/contacts`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/contacts`
- Auth: API key in header `api_access_token`

Create a new Contact

## Path parameters

- `workspace_id` integer, required

## Request body

- ContactCreatePayload
  - `inbox_id` number, required: ID of the inbox to which the contact belongs
  - `name` string: name of the contact
  - `email` string: email of the contact
  - `blocked` boolean: whether the contact is blocked or not
  - `phone_number` string: phone number of the contact
  - `avatar` string, binary: Send the form data with the avatar image binary or use the avatar_url
  - `avatar_url` string: The url to a jpeg, png file for the contact avatar
  - `identifier` string: A unique identifier for the contact in external system
  - `additional_attributes` object: An object where you can store additional attributes for contact. example {"type":"customer", "age":30}
  - `custom_attributes` object: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.

## Response `200`

Success

- ExtendedContact
  - `payload` object[]
    - `additional_attributes` object: The object containing additional attributes related to the contact
    - `availability_status` string: The availability status of the contact
    - `email` string: The email address of the contact
    - `id` integer: The ID of the contact
    - `name` string: The name of the contact
    - `phone_number` string: The phone number of the contact
    - `blocked` boolean: Whether the contact is blocked
    - `identifier` string: The identifier of the contact
    - `thumbnail` string: The thumbnail of the contact
    - `custom_attributes` object: The custom attributes of the contact
    - `last_activity_at` integer: The last activity at of the contact
    - `created_at` integer: The created at of the contact
    - `contact_inboxes` ContactInboxes[]
      - `source_id` string: Contact Inbox Source Id
      - `inbox` InboxContact
        - `id` number: ID of the inbox
        - `avatar_url` string: The avatar image of the inbox
        - `channel_id` number: The ID of the channel
        - `name` string: The name of the inbox
        - `channel_type` string: The type of the inbox
        - `provider` string: The provider of the inbox
  - `id` number: Id of the user
  - `availability_status` 'online' | 'offline': Availability status of the user

## Other responses

- `400`: Bad Request Error

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)