Upsert field mappings — Guide

First-request guide for Upsert field mappings.

API GUIDE

Upsert field mappings

Upsert field mappings

PUT/integration/v1/custom-sources/{source_id}/field-mappings/{object_type}JSONAuthentication required

Overview

Creates or replaces the field mappings for the given source and object type. The full set of mappings provided in the request body replaces any existing mappings.

Call the endpoint

Send a PUT request to /integration/v1/custom-sources/{source_id}/field-mappings/{object_type} with the required authentication and parameters.

Build the request body

Use the JSON shape below and replace example values with your data.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST
curl --request PUT \
  --url https://uapi.demandbase.com/integration/v1/custom-sources/1/field-mappings/account \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"fieldMappings":[{"sourceFieldLabel":"annual_revenue","demandbaseFieldName":"annualRevenue","dataType":"number"},{"sourceFieldLabel":"hq_country","demandbaseFieldName":"country","dataType":"string"}]}'
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 201
No response body (201 Created).

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

NameLocationTypeRequiredDescription
valueOptional
valueOptional

Request body

No fields are defined for this payload.

Response anatomy

The endpoint returns 201 for the documented success case. Field mappings upserted successfully. No content returned.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

  • Use PUT with the path /integration/v1/custom-sources/{source_id}/field-mappings/{object_type}.
  • Required inputs: No parameters are marked required in the published schema..
  • Authenticate every request with a valid Demandbase access token.
  • Send the request body as application/json.

Filters

This endpoint has no additional filters or parameters beyond its authentication requirements.

NameLocationTypeRequiredDescription
valueOptional
valueOptional

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

StatusMeaning
400Request failed.
401Request failed.
404Request failed.
500Request failed.

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to field-mappings

Back to top