Update a contact name / tags / custom attributes

curl --request PATCH \
  --url https://api.paigeme.dev/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "attributes": {}
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', tags: ['<string>'], attributes: {}})
};

fetch('https://api.paigeme.dev/v1/contacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/contacts/{id}"

payload = {
    "name": "<string>",
    "tags": ["<string>"],
    "attributes": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "contact": {
      "phone": "<string>",
      "bsuid": "<string>",
      "name": "<string>",
      "id": "<unknown>",
      "tags": "<unknown>",
      "attributes": "<unknown>"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

Update a contact name / tags / custom attributes

{id} is the contact phone (E.164) by default, or its BSUID with ?identifierType=bsuid. Tags accept a full-replacement array or an { add, remove } delta; attributes merge (a null value deletes the key).

At least one of name, tags or attributes is required — enforced by a cross-field rule the schema below cannot express, so an empty body is 400 invalid_request. An { add, remove } tag delta must itself carry a non-empty add or remove array.

Required scope: contacts:write

PATCH

contacts

{id}

Update a contact name / tags / custom attributes

curl --request PATCH \
  --url https://api.paigeme.dev/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "attributes": {}
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', tags: ['<string>'], attributes: {}})
};

fetch('https://api.paigeme.dev/v1/contacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/contacts/{id}"

payload = {
    "name": "<string>",
    "tags": ["<string>"],
    "attributes": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "contact": {
      "phone": "<string>",
      "bsuid": "<string>",
      "name": "<string>",
      "id": "<unknown>",
      "tags": "<unknown>",
      "attributes": "<unknown>"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Project API key issued in Settings → API keys. Send it as Authorization: Bearer pk_live_….

Headers

X-Paige-Project

string

Target project id, for an MCP OAuth bearer (mcp_at_…) attached to more than one project — get ids from GET /v1/projects. Matched case-insensitively.

Omit it and a READ falls back to the connection's default project; a mutation (any non-GET) on a connection with 2+ projects is rejected with 400 project_required — a write is never defaulted to a guessed project. A connection with exactly one project never needs the header.

Scopes are checked against the SELECTED project only, never a union across the connection.

For a pk_ API key the header selects nothing — one key is one project's context — but it IS validated: omit it and the key's own project is used, send it and it must name that project, otherwise the call is rejected with 403 project_not_attached (a blank value is 400 invalid_project_header, as above).

Path Parameters

string

required

Query Parameters

identifierType

enum<string>

Available options:

phone,

bsuid

Body

application/json

name

string | null

Maximum string length: 255

Response

Success.

success

enum<boolean>

required

Available options:

true

data

object

required

Hide child attributes

data.contact

object

required

Hide child attributes

data.contact.phone

string | null

required

data.contact.bsuid

string | null

required

data.contact.name

string | null

required

data.contact.id

any

data.contact.tags

any

data.contact.attributes

any

All messages for a contact (phone or BSUID)List the bot code files

Getting started

Endpoints

Update a contact name / tags / custom attributes

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response