Skip to content

Create SubscriberIDHistory

Request

Creates a new SubscriberIDHistory

Security
apiKeyAuth and bearerAuth
Path
newSubscriberIDstringrequired

New Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
change_IDinteger, (int32)required

Unique identifier for each Subscriber ID change process. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

error_Numberinteger or null, (int32)

Indicates if the process returned an error during the change procedure.

new_Subscriber_IDstring or null, <= 9 characters

The Subscriber_ID that Old_Subscriber_ID was changed to.

old_Subscriber_IDstring or null, <= 9 characters

The Subscriber_ID value that was changed.

table_Namestring or null, <= 64 characters

Indicates the table that an error occurred during the change procedure.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{newSubscriberID}/id-codes-history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "change_ID": 0,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "error_Number": 0,
    "new_Subscriber_ID": "string",
    "old_Subscriber_ID": "string",
    "table_Name": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}