Test And Accept Docs

Open Test And Accept

Pin a client

Pins a client to the top of the list

POST

https://api.testandaccept.com/api/rest/clients/{id}/pin

Authorization

bearerAuth
HTTP Bearer (tnda_ token)
required

Path parameters

id
string
required
format: uuid · pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Returns

200

Successful response

JSON

success
boolean
required

400

Invalid input data

JSON

message
string
required
The error message
code
string
required
The error code
issues
optional
array of
object
An array of issues that were responsible for the error
- message
  string
  required
}

401

Authorization not provided

JSON

message
string
required
The error message
code
string
required
The error code
issues
optional
array of
object
An array of issues that were responsible for the error
- message
  string
  required
}

403

Insufficient access

JSON

message
string
required
The error message
code
string
required
The error code
issues
optional
array of
object
An array of issues that were responsible for the error
- message
  string
  required
}

500

Internal server error

JSON

message
string
required
The error message
code
string
required
The error code
issues
optional
array of
object
An array of issues that were responsible for the error
- message
  string
  required
}

Pin a client

curl --request POST \
  --url 'https://api.testandaccept.com/api/rest/clients/<id>/pin' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.testandaccept.com/api/rest/clients/<id>/pin';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "success": true
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}