Relay docs
API ReferenceStores

Create a store

Creates a store. Requires the `contacts:write` scope. Deprecated alias of `/companies` (same fields, same ids). Keeps working until 16 February 2027 — the `Sunset` header — with `Deprecation` and `Link` headers on every response.

Deprecated

POST
/v1/public/stores

Authorization

bearerAuth
AuthorizationBearer <token>

Workspace API key, e.g. rl_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string
website?string|null
industry?string|null
notes?string|null
externalId?string|null

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/public/stores" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "website": "string",  "industry": "string",  "notes": "string",  "externalId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "error": "string"}
{  "error": "string"}

Update a store PATCH

Updates a store's details. Only the provided fields are changed. Requires the `contacts:write` scope. Deprecated alias of `/companies` (same fields, same ids). Keeps working until 16 February 2027 — the `Sunset` header — with `Deprecation` and `Link` headers on every response.

CLI

Manage conversations and contacts from your terminal with the Relay CLI.