Jump to

• Request
• Response

Merge Table Members with PK

post

/rest/api/v1.3/lists/{listName}/customTable/{tableName}/members

Request

Path Parameters

• listName: string
  List name
• tableName: string
  Table Name

Body ()

Request Body

Root Schema : Custom Table Members with PK

Type: object

Title: Custom Table Members with PK

Show Source

• insertOnNoMatch(optional): boolean
  Specifies whether a member record should be inserted into the Custom Table if it does not already exist.
• recordData(optional): object recordData
  Record data that represents Field Names and corresponding values for the member.
• required(optional):
• updateOnMatch(optional): string
  Allowed Values: [ "REPLACE_ALL", "NO_UPDATE" ]

  Specifies whether a member record should be updated in the Custom Table if it already exists.

{
    "title":"Custom Table Members with PK",
    "type":"object",
    "properties":{
        "recordData":{
            "description":"Record data that represents Field Names and corresponding values for the member.",
            "required":[
                "fieldNames",
                "records"
            ],
            "type":"object",
            "properties":{
                "fieldNames":{
                    "type":"array",
                    "description":"Field Names in the Custom Table",
                    "items":{
                        "type":"string"
                    }
                },
                "records":{
                    "type":"array",
                    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
                    "items":{
                        "type":"array",
                        "description":"Field Values for the member in the Custom Table",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "mapTemplateName":{
                    "type":"string",
                    "description":"The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names."
                }
            }
        },
        "insertOnNoMatch":{
            "description":"Specifies whether a member record should be inserted into the Custom Table if it does not already exist.",
            "type":"boolean"
        },
        "updateOnMatch":{
            "description":"Specifies whether a member record should be updated in the Custom Table if it already exists.",
            "enum":[
                "REPLACE_ALL",
                "NO_UPDATE"
            ],
            "type":"string"
        },
        "required":{
        }
    }
}

Nested Schema : recordData

Type: object

Record data that represents Field Names and corresponding values for the member.

Show Source

• fieldNames: array fieldNames
  Field Names in the Custom Table
• mapTemplateName(optional): string
  The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names.
• records: array records
  Array of values corresponding to the fieldNames. Each element in the array represents a single member.

{
    "description":"Record data that represents Field Names and corresponding values for the member.",
    "required":[
        "fieldNames",
        "records"
    ],
    "type":"object",
    "properties":{
        "fieldNames":{
            "type":"array",
            "description":"Field Names in the Custom Table",
            "items":{
                "type":"string"
            }
        },
        "records":{
            "type":"array",
            "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
            "items":{
                "type":"array",
                "description":"Field Values for the member in the Custom Table",
                "items":{
                    "type":"string"
                }
            }
        },
        "mapTemplateName":{
            "type":"string",
            "description":"The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names."
        }
    }
}

Nested Schema : fieldNames

Type: array

Field Names in the Custom Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field Names in the Custom Table",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

Array of values corresponding to the fieldNames. Each element in the array represents a single member.

Show Source

• Array of: array items
  Field Values for the member in the Custom Table

{
    "type":"array",
    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
    "items":{
        "type":"array",
        "description":"Field Values for the member in the Custom Table",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Field Values for the member in the Custom Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field Values for the member in the Custom Table",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Custom Table Members with PK

Type: object

Title: Custom Table Members with PK

Show Source

• insertOnNoMatch(optional): boolean
  Specifies whether a member record should be inserted into the Custom Table if it does not already exist.
• recordData(optional): object recordData
  Record data that represents Field Names and corresponding values for the member.
• required(optional):
• updateOnMatch(optional): string
  Allowed Values: [ "REPLACE_ALL", "NO_UPDATE" ]

  Specifies whether a member record should be updated in the Custom Table if it already exists.

{
    "title":"Custom Table Members with PK",
    "type":"object",
    "properties":{
        "recordData":{
            "description":"Record data that represents Field Names and corresponding values for the member.",
            "required":[
                "fieldNames",
                "records"
            ],
            "type":"object",
            "properties":{
                "fieldNames":{
                    "type":"array",
                    "description":"Field Names in the Custom Table",
                    "items":{
                        "type":"string"
                    }
                },
                "records":{
                    "type":"array",
                    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
                    "items":{
                        "type":"array",
                        "description":"Field Values for the member in the Custom Table",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "mapTemplateName":{
                    "type":"string",
                    "description":"The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names."
                }
            }
        },
        "insertOnNoMatch":{
            "description":"Specifies whether a member record should be inserted into the Custom Table if it does not already exist.",
            "type":"boolean"
        },
        "updateOnMatch":{
            "description":"Specifies whether a member record should be updated in the Custom Table if it already exists.",
            "enum":[
                "REPLACE_ALL",
                "NO_UPDATE"
            ],
            "type":"string"
        },
        "required":{
        }
    }
}

Nested Schema : recordData

Type: object

Record data that represents Field Names and corresponding values for the member.

Show Source

• fieldNames: array fieldNames
  Field Names in the Custom Table
• mapTemplateName(optional): string
  The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names.
• records: array records
  Array of values corresponding to the fieldNames. Each element in the array represents a single member.

{
    "description":"Record data that represents Field Names and corresponding values for the member.",
    "required":[
        "fieldNames",
        "records"
    ],
    "type":"object",
    "properties":{
        "fieldNames":{
            "type":"array",
            "description":"Field Names in the Custom Table",
            "items":{
                "type":"string"
            }
        },
        "records":{
            "type":"array",
            "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
            "items":{
                "type":"array",
                "description":"Field Values for the member in the Custom Table",
                "items":{
                    "type":"string"
                }
            }
        },
        "mapTemplateName":{
            "type":"string",
            "description":"The Map Template in CX Audience that can be used to map Field Names of the Custom Table to Column Names."
        }
    }
}

Nested Schema : fieldNames

Type: array

Field Names in the Custom Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field Names in the Custom Table",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

Array of values corresponding to the fieldNames. Each element in the array represents a single member.

Show Source

• Array of: array items
  Field Values for the member in the Custom Table

{
    "type":"array",
    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single member.",
    "items":{
        "type":"array",
        "description":"Field Values for the member in the Custom Table",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Field Values for the member in the Custom Table

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field Values for the member in the Custom Table",
    "items":{
        "type":"string"
    }
}

Back to Top