Create

Create

Create

Adds a terms entry to an account.

Request

Method
URL
POST

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
terms

Text
The label for the terms entry. Maximum length is 32 characters and it cannot be empty.
active
Boolean
Indicates if the terms entry is active or inactive. The default is active.
{
"terms": "Net 30",
"active": true
}

Remarks

terms is required, cannot be empty, and cannot exceed 32 characters.
A terms label must be unique within an account. If a terms entry with the same label already exists for the account, the request will fail with a 409 Conflict.
If active is omitted, the terms entry is created as active.

Response

Headers

Location — the URL of the newly created terms entry.

Status Code

Code
Description
201 Created
The terms entry was created.
400 Bad Request
The terms entry was not created. This occurs if terms is missing, empty, or exceeds 32 characters.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
409 Conflict
Terms with that label already exist for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the terms entry.
terms
Text
The label for the terms entry.
active
Boolean
Indicates if the terms entry is active or inactive.