Create client

Requires the clientCreate access right for project managers. Client names must be unique within the organization.

POST /api2/v1/clients

Create client

cURL

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/clients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayNoteInProject": true,
  "externalId": "<string>",
  "note": "<string>"
}
'

201

{
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "uid": "<string>",
    "userName": "<string>"
  },
  "displayNoteInProject": true,
  "externalId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "netRateScheme": {
    "createdBy": {
      "email": "<string>",
      "firstName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "uid": "<string>",
      "userName": "<string>"
    },
    "dateCreated": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "isDefault": true,
    "name": "<string>",
    "uid": "<string>"
  },
  "note": "<string>",
  "priceList": {
    "id": "<string>",
    "name": "<string>",
    "uid": "<string>"
  },
  "uid": "<string>"
}

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

name · string · required

Maximum string length: 255

displayNoteInProject · boolean

When true, the client note is shown on projects associated with this client

externalId · string

External identifier; max 255 characters

Maximum string length: 255

netRateScheme · object

Show child attributes

note · string

Note; max 4096 characters

Maximum string length: 4096

priceList · object

Show child attributes

Response

201

application/json

Created

createdBy · object

Show child attributes

displayNoteInProject · boolean

When true, the client note is shown on projects associated with this client

externalId · string

External identifier from an external system

id · string

Internal numeric identifier, encoded as a string

name · string

Human-readable name of the client; unique within the organization

netRateScheme · object

Show child attributes

note · string

Client note

priceList · object

Show child attributes

uid · string

Unique identifier used in API paths