/clicksend-contacts | Type: Application | PCID required: Yes
Tools
clicksend_contacts_lists_by_list_id_delete
ListsByListIdDelete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | List ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "List ID"
}
},
"required": [
"PCID",
"list_id"
]
}
clicksend_contacts_lists_by_list_id_get
Get specific contact list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | List ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "List ID"
}
},
"required": [
"PCID",
"list_id"
]
}
clicksend_contacts_lists_by_list_id_put
Update specific contact list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Your list id |
list_name | string | Yes | — | Your list name. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Your list id"
},
"list_name": {
"type": "string",
"description": "Your list name."
}
},
"required": [
"PCID",
"list_id",
"list_name"
]
}
clicksend_contacts_lists_contacts_by_list_id_and_contact_id_delete
Delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | List ID |
contact_id | integer | Yes | — | Contact ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "List ID"
},
"contact_id": {
"type": "integer",
"description": "Contact ID"
}
},
"required": [
"PCID",
"list_id",
"contact_id"
]
}
clicksend_contacts_lists_contacts_by_list_id_and_contact_id_get
Get a specific contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Your contact list id you want to access. |
contact_id | integer | Yes | — | Your contact id you want to access. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Your contact list id you want to access."
},
"contact_id": {
"type": "integer",
"description": "Your contact id you want to access."
}
},
"required": [
"PCID",
"list_id",
"contact_id"
]
}
clicksend_contacts_lists_contacts_by_list_id_and_contact_id_put
Update specific contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Contact list id |
contact_id | integer | Yes | — | Contact ID |
address_city | string | No | — | Your nearest city |
address_country | string | No | — | Your current country |
address_line_1 | string | No | — | Your street address |
address_line_2 | string | No | — | Address Line 2 |
address_postal_code | string | No | — | Your current postcode |
address_state | string | No | — | Your current state |
custom_1 | string | No | — | Custom 1 |
custom_2 | string | No | — | Custom 2 |
custom_3 | string | No | — | Custom 3 |
custom_4 | string | No | — | Custom 4 |
email | string | No | — | Your email. Must be provided if no phone number or fax number. |
fax_number | string | No | — | Your fax number. Must be provided if no phone number or email. |
first_name | string | No | — | Your first name. |
last_name | string | No | — | Your last name |
organization_name | string | No | — | Your organisation name |
phone_number | string | No | — | Your phone number in E.164 format. Must be provided if no fax number or email. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Contact list id"
},
"contact_id": {
"type": "integer",
"description": "Contact ID"
},
"address_city": {
"type": "string",
"description": "Your nearest city"
},
"address_country": {
"type": "string",
"description": "Your current country"
},
"address_line_1": {
"type": "string",
"description": "Your street address"
},
"address_line_2": {
"type": "string",
"description": "Address Line 2"
},
"address_postal_code": {
"type": "string",
"description": "Your current postcode"
},
"address_state": {
"type": "string",
"description": "Your current state"
},
"custom_1": {
"type": "string",
"description": "Custom 1"
},
"custom_2": {
"type": "string",
"description": "Custom 2"
},
"custom_3": {
"type": "string",
"description": "Custom 3"
},
"custom_4": {
"type": "string",
"description": "Custom 4"
},
"email": {
"type": "string",
"description": "Your email. Must be provided if no phone number or fax number."
},
"fax_number": {
"type": "string",
"description": "Your fax number. Must be provided if no phone number or email."
},
"first_name": {
"type": "string",
"description": "Your first name."
},
"last_name": {
"type": "string",
"description": "Your last name"
},
"organization_name": {
"type": "string",
"description": "Your organisation name"
},
"phone_number": {
"type": "string",
"description": "Your phone number in E.164 format. Must be provided if no fax number or email."
}
},
"required": [
"PCID",
"list_id",
"contact_id"
]
}
clicksend_contacts_lists_contacts_by_list_id_get
Get all contacts in a list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Contact list ID |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
updated_after | integer | No | — | Get all contacts updated after a given timestamp. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Contact list ID"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
},
"updated_after": {
"type": "integer",
"description": "Get all contacts updated after a given timestamp."
}
},
"required": [
"PCID",
"list_id"
]
}
clicksend_contacts_lists_contacts_by_list_id_post
Create new contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | List id |
address_city | string | No | — | Your nearest city |
address_country | string | No | — | Your current country |
address_line_1 | string | No | — | Your street address |
address_line_2 | string | No | — | Address Line 2 |
address_postal_code | string | No | — | Your current postcode |
address_state | string | No | — | Your current state |
custom_1 | string | No | — | Custom 1 |
custom_2 | string | No | — | Custom 2 |
custom_3 | string | No | — | Custom 3 |
custom_4 | string | No | — | Custom 4 |
email | string | No | — | Your email. Must be provided if no phone number or fax number. |
fax_number | string | No | — | Your fax number. Must be provided if no phone number or email. |
first_name | string | No | — | Your first name. |
last_name | string | No | — | Your last name |
organization_name | string | No | — | Your organisation name |
phone_number | string | No | — | Your phone number in E.164 format. Must be provided if no fax number or email. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "List id"
},
"address_city": {
"type": "string",
"description": "Your nearest city"
},
"address_country": {
"type": "string",
"description": "Your current country"
},
"address_line_1": {
"type": "string",
"description": "Your street address"
},
"address_line_2": {
"type": "string",
"description": "Address Line 2"
},
"address_postal_code": {
"type": "string",
"description": "Your current postcode"
},
"address_state": {
"type": "string",
"description": "Your current state"
},
"custom_1": {
"type": "string",
"description": "Custom 1"
},
"custom_2": {
"type": "string",
"description": "Custom 2"
},
"custom_3": {
"type": "string",
"description": "Custom 3"
},
"custom_4": {
"type": "string",
"description": "Custom 4"
},
"email": {
"type": "string",
"description": "Your email. Must be provided if no phone number or fax number."
},
"fax_number": {
"type": "string",
"description": "Your fax number. Must be provided if no phone number or email."
},
"first_name": {
"type": "string",
"description": "Your first name."
},
"last_name": {
"type": "string",
"description": "Your last name"
},
"organization_name": {
"type": "string",
"description": "Your organisation name"
},
"phone_number": {
"type": "string",
"description": "Your phone number in E.164 format. Must be provided if no fax number or email."
}
},
"required": [
"PCID",
"list_id"
]
}
clicksend_contacts_lists_copy_contact_put
Copy contact to another list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from_list_id | integer | Yes | — | List ID for list that contains contact. |
contact_id | integer | Yes | — | Contact ID |
to_list_id | integer | Yes | — | List ID for list you want to copy the contact to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"from_list_id": {
"type": "integer",
"description": "List ID for list that contains contact."
},
"contact_id": {
"type": "integer",
"description": "Contact ID"
},
"to_list_id": {
"type": "integer",
"description": "List ID for list you want to copy the contact to."
}
},
"required": [
"PCID",
"from_list_id",
"contact_id",
"to_list_id"
]
}
clicksend_contacts_lists_get
Get all contact lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
}
},
"required": [
"PCID"
]
}
clicksend_contacts_lists_import_by_list_id_post
Import contacts to list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Your contact list id you want to access. |
field_order | string[] | Yes | — | Order of fields in file |
file_url | string | Yes | — | URL of file to process |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Your contact list id you want to access."
},
"field_order": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order of fields in file"
},
"file_url": {
"type": "string",
"description": "URL of file to process"
}
},
"required": [
"PCID",
"list_id",
"field_order",
"file_url"
]
}
clicksend_contacts_lists_post
Create new contact list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_name | string | Yes | — | Your list name. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_name": {
"type": "string",
"description": "Your list name."
}
},
"required": [
"PCID",
"list_name"
]
}
clicksend_contacts_lists_remove_duplicates_by_list_id_put
Remove duplicate contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Your list id |
fields | object | Yes | — | From Email object. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Your list id"
},
"fields": {
"description": "From Email object."
}
},
"required": [
"PCID",
"list_id",
"fields"
]
}
clicksend_contacts_lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put
Remove all opted out contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | integer | Yes | — | Your list id |
opt_out_list_id | integer | Yes | — | Your opt out list id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "integer",
"description": "Your list id"
},
"opt_out_list_id": {
"type": "integer",
"description": "Your opt out list id"
}
},
"required": [
"PCID",
"list_id",
"opt_out_list_id"
]
}
clicksend_contacts_lists_transfer_contact_put
Transfer contact to another list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from_list_id | integer | Yes | — | List ID for list that contains contact. |
contact_id | integer | Yes | — | Contact ID |
to_list_id | integer | Yes | — | List ID for list you want to transfer contact to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"from_list_id": {
"type": "integer",
"description": "List ID for list that contains contact."
},
"contact_id": {
"type": "integer",
"description": "Contact ID"
},
"to_list_id": {
"type": "integer",
"description": "List ID for list you want to transfer contact to."
}
},
"required": [
"PCID",
"from_list_id",
"contact_id",
"to_list_id"
]
}