POST /api/v1/mappings/{mappingId}

Updates an existing profile mapping by adding, updating, or removing one or many property mappings

Servers

Path parameters

Name Type Required Description
mappingId String Yes

id of the Mapping

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
properties Object Yes
properties.name Object No

A target property, in string form, that maps to a valid JSON Schema Draft document.

properties.name.expression String No

Combination or single source properties that are mapped to the target property

properties.name.pushStatus String No

Indicates whether to update target properties for user create and update or just for user create.

Having a pushStatus of PUSH causes properties in the target to be updated on create and update. Having a pushStatus of DONT_PUSH causes properties in the target to be updated only on create.

Possible values:

  • "PUSH"
  • "DONT_PUSH"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.