Skip to content

Area: Developers

B2B API overview

The B2B API creates, updates and deletes the companies of one shop, and links profiles to companies with roles. Every call is under https://releva.ai/api/v0 and is made from your server with your shop’s Secret Key.

Call Endpoint Purpose
Create or update companies POST /companies Create or replace companies.
Delete a company DELETE /companies/{companyId} Delete one company.
Link profiles to companies POST /roles Link profiles to companies with a role, creating the profiles if needed.
Remove a profile from a company DELETE /roles/{companyId}/{emailOrPhone} Unlink one profile from one company.

When to use it. Integrate these calls if you use Releva in a B2B context, where buyers act for companies. A B2C shop only needs the profile calls. For how companies, roles and events fit together, read Companies and roles.

There is no call to read companies or roles back. They are visible in the admin under Data Platform › Companies and usable in segments.

POST /api/v0/companies creates companies or replaces them whole. See Create or update companies.

DELETE /api/v0/companies/{companyId} deletes one company and keeps its roles. See Delete a company.

POST /api/v0/roles links profiles to companies with a role. See Link profiles to companies.

DELETE /api/v0/roles/{companyId}/{emailOrPhone} removes one link and keeps the profile and the company. See Remove a profile from a company.

  • Send your shop’s Secret Key as authorization: Bearer $RELEVA_SECRET_KEY. Find it under Settings › Shop & Integration; see Find your Access Token and Secret Key.
  • Authentication failures answer 400, not 401. A disabled shop answers 402.
  • HTTPS only. Send JSON with content-type: application/json.
  • Every successful call answers 202 Accepted with {}. Companies and roles are written in the background and show in the admin shortly after. See Writes are asynchronous.
  • Errors have one shape, { "message": "..." }, except the plain-text 400 described in Link profiles to companies.
  • Bodies are limited to 800 KB (413 above that). There are no rate limits on these calls.
  • Unknown fields are rejected. All calls are under /api/v0. Changes are listed in the API changelog.