Campaigns

Retrieve the variable schema and lead schema mapping for a specific campaign

get/campaigns/{campaignId}/schemas

Request

  • Base URL: https://api.pitchlane.com/api/public/v1
  • URL: https://api.pitchlane.com/api/public/v1/campaigns/{campaignId}/schemas
  • Auth: API key in header X-API-Key

Path parameters

campaignIdstring required

The unique identifier of the campaign for which the schema is being retrieved

Response

Returns both variable and lead schema mappings along with their example payloads

variableSchemaobject

The schema for the variables associated with the campaign

exampleVariableSchemaPayloadobject

An example payload that adheres to the variable schema

leadSchemaMappingobject

The schema for the leads associated with the campaign. The keys of this should be what goes in your API request body.

exampleLeadSchemaMappingPayloadobject

An example payload that adheres to the lead schema

Changes

No recorded changes to this operation across all 1 revision of this API.