Create tool | Atlas | Documentation

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

This endpoint expects an object.

NamestringRequired

TypeenumRequired

Allowed values:

SettingsstringOptional

JSON-serialized tool settings

TemplateIdstringOptional

CategoriesstringOptional

GroupstringOptional

PurposestringOptional

Tool created

Namestring

Typeenum

Allowed values:

Settingsstring

JSON-serialized tool settings

TemplateIdstring

Categoriesstring

Groupstring

Purposestring

PartitionKeystring

RowKeystring

Timestampdatetime

Statusenum

Allowed values:

400

Bad Request Error

500

Internal Server Error

1	curl -X POST https://api.youratlas.com/v1/api/tools \
2	-H "api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"Name": "Customer Engagement SMS",
6	"Type": "SMSOneWay"
7	}'

1	{
2	"Name": "Customer Engagement SMS",
3	"Type": "SMSOneWay",
4	"Settings": "{\"maxLength\":160,\"senderId\":\"AtlasSMS\"}",
5	"TemplateId": "tmpl_987654321",
6	"Categories": "Marketing,Customer Retention",
7	"Group": "SMS Campaigns",
8	"Purpose": "Send promotional messages to customers",
9	"PartitionKey": "tools",
10	"RowKey": "tool_123456789",
11	"Timestamp": "2024-01-15T09:30:00Z",
12	"Status": "Approved"
13	}