Skip to content

CustomFieldApi.md

Latest commit

 

History

History
271 lines (177 loc) · 7.65 KB

CustomFieldApi.md

File metadata and controls

271 lines (177 loc) · 7.65 KB
Raw

sendx.CustomFieldApi

All URIs are relative to https://api.sendx.io/api/v1/rest

Method HTTP request Description
createCustomField POST /customfield Create custom field
deleteCustomField DELETE /customfield/{identifier} Delete custom field
getAllCustomFields GET /customfield Get all custom fields
getCustomField GET /customfield/{identifier} Get custom field by ID
updateCustomField PUT /customfield/{identifier} Update custom field

createCustomField

RestRCustomField createCustomField(restECustomField)

Create custom field

Creates a new custom field for storing contact data.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.CustomFieldApi();
let restECustomField = new sendx.RestECustomField(); // RestECustomField | 
apiInstance.createCustomField(restECustomField).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
restECustomField RestECustomField

Return type

RestRCustomField

Authorization

TeamApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteCustomField

DeleteResponse deleteCustomField(identifier)

Delete custom field

Deletes a custom field (data is preserved). 🎯 Key Features: - Remove unused fields - Data remains on contacts - Clean up field list

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.CustomFieldApi();
let identifier = "identifier_example"; // String | Custom field identifier to update
apiInstance.deleteCustomField(identifier).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String Custom field identifier to update

Return type

DeleteResponse

Authorization

TeamApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAllCustomFields

[RestRCustomField] getAllCustomFields(opts)

Get all custom fields

Retrieves all custom fields defined for your team.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.CustomFieldApi();
let opts = {
  'offset': 0, // Number | Number of fields to skip for pagination
  'limit': 10, // Number | Maximum number of fields to return
  'search': "search_example" // String | Search custom fields by name (case-insensitive partial matching).  **Examples:** - `points` - Finds \"Loyalty points\", \"Reward points\" 
};
apiInstance.getAllCustomFields(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
offset Number Number of fields to skip for pagination [optional] [default to 0]
limit Number Maximum number of fields to return [optional] [default to 10]
search String Search custom fields by name (case-insensitive partial matching). Examples: - `points` - Finds "Loyalty points", "Reward points" [optional]

Return type

[RestRCustomField]

Authorization

TeamApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCustomField

RestRCustomField getCustomField(identifier)

Get custom field by ID

Retrieves details about a specific custom field.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.CustomFieldApi();
let identifier = "identifier_example"; // String | Custom field identifier to update
apiInstance.getCustomField(identifier).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String Custom field identifier to update

Return type

RestRCustomField

Authorization

TeamApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateCustomField

RestRCustomField updateCustomField(restECustomField, identifier)

Update custom field

Updates a custom field definition.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.CustomFieldApi();
let restECustomField = {"name":"Customer Tier","description":"Customer segmentation tier (Bronze/Silver/Gold)"}; // RestECustomField | 
let identifier = "identifier_example"; // String | Custom field identifier to update
apiInstance.updateCustomField(restECustomField, identifier).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
restECustomField RestECustomField
identifier String Custom field identifier to update

Return type

RestRCustomField

Authorization

TeamApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json