Update contact shares

Add or remove the users, groups, or organization a contact is shared with. Only the shares you name change; the contact’s other shares stay as they are.

PATCH /contacts/{contactId}/shares

Update contact shares

cURL

curl --request PATCH \
  --url https://dev-public-api.openphone.dev/contacts/{contactId}/shares \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "add": [
    "US123abc",
    "GR123abc"
  ],
  "remove": [
    "US456def"
  ]
}
'

200

Example

{
  "data": {
    "contactId": "6a145ff26212a192852c856e",
    "added": [
      "US123abc",
      "GR123abc"
    ],
    "removed": [
      "US456def"
    ]
  }
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Path Parameters

contactId · string · required

The unique identifier of the contact whose shares are being updated.

Pattern: ^(.*)$

Example:

"6a145ff26212a192852c856e"

Body

application/json

add · string[]

The IDs of the users, groups, or organization to share the contact with, in addition to its current shares. User IDs start with US, group IDs start with GR, and organization IDs start with OR. Each must belong to your organization. Sharing with your organization shares the contact with everyone in it.

Maximum array length: 100

A user, group, or organization ID. User IDs start with US, group IDs start with GR, and organization IDs start with OR.

Pattern: ^(US|GR|OR)(.*)$

Example:

["US123abc", "GR123abc"]

remove · string[]

The IDs of the users, groups, or organization to stop sharing the contact with. User IDs start with US, group IDs start with GR, and organization IDs start with OR. IDs the contact isn't shared with are ignored. The contact's owner (the actorId returned by the list and get contact endpoints) cannot be removed: naming them here leaves them shared, and they are not included in removed.

Maximum array length: 100

A user, group, or organization ID. User IDs start with US, group IDs start with GR, and organization IDs start with OR.

Pattern: ^(US|GR|OR)(.*)$

Example:

["US456def"]

Response

200

application/json

OK

data · object · required

Show child attributes