Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

With this API, you can view, add, edit, and delete tags in a project.

Reading.

Allows you to view the created tags in the project.

 

GET https://api.smartsender.com/v1/tags

 

Main parameters:

Name

Description

Validation

page

Requested Page

Minimum value 1

limitation

Amount of data to display per page

Minimum value 1, maximum 20

term

Search string

 

 

In case of a successful response, you will receive the following:

 

{
    "cursor": Cursor,
    "collection": Tag[]
}

 

Main parameters:

Name

Description

cursor

Cursor an object

collection

Array Tag an objects

 

Creation.

Allows you to create a tag in a project.

 

POST https://api.smartsender.com/v1/tags

 

Основные параметры:

Name

Description

Validation

name

Name

Unique within the project

color

Color

6 characters for HEX designation

 

If the response is successful, get the created Tag object.

 

Update.

Allows you to update an existing tag.

 

PUT https://api.smartsender.com/v1/tags/{tagId}

 

Основные параметры:

Name

Description

Validation

name

Name

Unique within the project

color

Color

6 characters for HEX designation

 

In case of a successful response, you will receive the following:

 

{
    "state": true
}

 

Delete

Allows you to delete an existing tag.

 

DELETE https://api.smartsender.com/v1/tags/{tagId}

 

In case of a successful response, you will receive the following:

 

{
    "state": true
}

  • No labels