This API allows you to send bulk company updates to Releva. Any company which do not exist in Releva will be created.
Any change will be available according to our SLA.
Do I need to call it? #
This API should be integrated if you intend to use Releva in a B2B context. For B2C, you only need the APIs for creating / updating / deleting profiles.
Request Parameters #
You may perform requests to the API using the following curl equivalent:
curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XPOST https://releva.ai/api/v0/companies -d'{
"companies": [
{
"email": "info@releva.ai",
"name": "Releva.AI",
"companyId": "123",
"phoneNumber": "+359....",
"tags": [
"active",
"acceptingMessages"
],
"custom": {
"string": [
{"key": "industry", "values": ["E-commerce"]},
{"key": "location", "values": ["EU"]}
]
},
},
{
"email": "info@google.com",
"name": "Google",
"companyId": "234",
"phoneNumber": "+1....",
"tags": [
"active",
"acceptingMessages"
],
"custom": {
"string": [
{"key": "industry", "values": ["Internet"]},
{"key": "location", "values": ["USA"]}
]
},
},
]
}'
The companies Object #
| Field | Type | Description |
|---|---|---|
| companies[].companyId | String | The company’s unique identifier. |
| companies[].name | String | The name of the company |
| companies[].email | String (Optional) | The contact email of the company |
| companies[].phoneNumber | String (Optional) | The contact phone number of the company. Phone numbers must start with “+” followed by a sequence of numbers. Valid phone number: +49875345976. |
| companies[].custom | Object (Optional) | Custom fields for the company. Can be used to build segments and conditions in workflows. |
| companies[].tags | Array[String] (Optional) | A list of tags to associate to the company. |
A successful response will return HTTP Status 202 with an empty response body ({}).
Response Format #
An error response will return a HTTP 4xx or 5xx status code and have the following structure:
{
"message": "A description of the error and how to fix it, if it's a client error."
}