Create or replace a record
Creates a record, or replaces an existing record with the same record_key. A replace overwrites every field: fields you leave out are cleared, so send the old values of fields you want to keep.
Authorization
bearerAuth Access token from POST /oauth2/token (valid for 300 seconds).
In: header
Request Body
application/json
A record stored in the InCountry Vault. Hashed fields are stored as hashes, encrypted fields are encrypted with AES-GCM (256-bit key, 96-bit nonce), plain fields are stored as-is.
Unique identifier (primary key) of the record. Hashed.
Legacy alias of record_key, returned by the API.
Record payload. You can store stringified JSON. Encrypted.
Service information about the record. Encrypted.
Identifier of the record in an external system. Hashed.
Key of the parent record. Hashed.
Legacy alias of range_key1.
Numeric field for range filtering (1 of 10). Plain.
Numeric field for range filtering (2 of 10). Plain.
Numeric field for range filtering (3 of 10). Plain.
Numeric field for range filtering (4 of 10). Plain.
Numeric field for range filtering (5 of 10). Plain.
Numeric field for range filtering (6 of 10). Plain.
Numeric field for range filtering (7 of 10). Plain.
Numeric field for range filtering (8 of 10). Plain.
Numeric field for range filtering (9 of 10). Plain.
Numeric field for range filtering (10 of 10). Plain.
Additional text information (1 of 5). Hashed.
Additional text information (2 of 5). Hashed.
Additional text information (3 of 5). Hashed.
Additional text information (4 of 5). Hashed.
Additional text information (5 of 5). Hashed.
Lookup field (1 of 20). Hashed or plain, depending on your configuration.
Lookup field (2 of 20). Hashed or plain, depending on your configuration.
Lookup field (3 of 20). Hashed or plain, depending on your configuration.
Lookup field (4 of 20). Hashed or plain, depending on your configuration.
Lookup field (5 of 20). Hashed or plain, depending on your configuration.
Lookup field (6 of 20). Hashed or plain, depending on your configuration.
Lookup field (7 of 20). Hashed or plain, depending on your configuration.
Lookup field (8 of 20). Hashed or plain, depending on your configuration.
Lookup field (9 of 20). Hashed or plain, depending on your configuration.
Lookup field (10 of 20). Hashed or plain, depending on your configuration.
Lookup field (11 of 20). Hashed or plain, depending on your configuration.
Lookup field (12 of 20). Hashed or plain, depending on your configuration.
Lookup field (13 of 20). Hashed or plain, depending on your configuration.
Lookup field (14 of 20). Hashed or plain, depending on your configuration.
Lookup field (15 of 20). Hashed or plain, depending on your configuration.
Lookup field (16 of 20). Hashed or plain, depending on your configuration.
Lookup field (17 of 20). Hashed or plain, depending on your configuration.
Lookup field (18 of 20). Hashed or plain, depending on your configuration.
Lookup field (19 of 20). Hashed or plain, depending on your configuration.
Lookup field (20 of 20). Hashed or plain, depending on your configuration.
When the record is automatically deleted from the InCountry Vault (ISO-8601).
date-timeLowercase ISO country code where the record is stored.
Response Body
application/json
curl -X POST "https://example.com/api/records" \ -H "Content-Type: application/json" \ -d '{ "record_key": "d1c2e12cfeababc8b95daf6902e210b1", "profile_key": "4274e510a2f41aeb9e8e0f8b56ff6c2", "range_key1": 2000, "key1": "Additional info", "key4": "Shipping", "key10": "New", "body": "{\\"name\\":\\"John\\",\\"vehicle\\":\\"Audi\\"}", "country": "se" }'{ "country": "se", "key": "d1c2e12cfeababc8b95daf6902e210b1", "record_key": "d1c2e12cfeababc8b95daf6902e210b1", "profile_key": "4274e510a2f41aeb9e8e0f8b56ff6c2", "range_key": 2000, "range_key1": 2000, "body": "{\"name\":\"John\",\"vehicle\":\"Audi\"}", "key1": "Additional info", "key4": "Shipping", "key10": "New"}Request an access token POST
Exchanges the Client ID and Client Secret of a REST API integration (created on the InCountry Portal) for an access token. Send the credentials with Basic auth. Tokens are valid for **300 seconds**; request a new one when it expires.
Duplicate a record POST
Duplicates the record matching `filter`, as-is or with the values in `update_with` applied to the copy.