# Contact lists

# Create contact list

# Description

You can use this API to create contact list.

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
newCL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
cl	object	Contains the Details of the contact list that you want to create	✔️
destinations	object	Contains all the numbers have been added to a contact list	✔️
destination	object	contains the details for any phone number.	✔️
phone	int	must be formatted: 5xxxxxxx or 05xxxxxxx.	✔️
df1/ df2/ df3/ df4/ df5/ df6	string	contains a dynamic field for all listed phone number	➖

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

# Remove contact list

# Description

You can use this API to remove contact lists.

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
removeCL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
cl	object	Contains identifiers you want to remove.	✔️
id	string	Contains an id of contact list you want to remove.	✔️

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

# Add a number to existing contact list

# Description

You can use this API to add numbers to an existing contact list.

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
addNumCL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
cl	object	Contains the details of the contact list that you want to update.	✔️
id	int	Contains the id of the contact list you want to update.	✔️
destinations	object	Contains all the numbers you want to add to this contact list	✔️
destination	object	contains the details for the phone number.	✔️
phone	int	must be formatted: 5xxxxxxx or 05xxxxxxx	✔️
df1/ df2/ df3/ df4/ df5/ df6	string	contains a dynamic field for this phone number in this contact list	➖

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

# Remove a number from an existing contact lists

# Description

You can use this API to remove numbers from an existing contact list.

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
rmNumCL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
cl	object	Contains the details of the contact list that you want to update.	✔️
id	int	Contains the id of the contact list you want to update.	✔️
destination	object	Contains all the numbers want to remove from the contact list.	✔️
phone	int	must be formatted: 5xxxxxxx or 05xxxxxxx	✔️

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

# Get all contact lists

# Description

You can use this API to get the contact lists (include empty contact lists).

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
getCL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

# Get contact lists by ID

# Description

You can use this API to get contact lists by ID.

# Endpoint

    POST https://my.textme.co.il/api

# Parameters

Name	Type	Description	Required
getCLbyID	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
cl	object	Contains contact list elements	✔️
id	int	Contains the id of the contact list you want to get.	✔️

# Request Example

xml

Copy code

# Response Example

xml

Copy code

Note

Full description of the response status and message can be found in here:

← Subscribers Cancel campaign →