Activate an agent

POST

/api/v3/agents/{agentUuid}/actions/activate

const url = 'https://api.tryletterhead.com/api/v3/agents/example/actions/activate';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"api":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.tryletterhead.com/api/v3/agents/example/actions/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api": true }'

Authorizations

bearerAuth

Parameters

Path Parameters

agentUuid

required

string

The agent’s unique identifier.

Request Body^required

application/json

object

api

Required. Set to true to authenticate with an API key.

boolean

Example

{
  "api": true
}

Responses

200

Successful response

Still can’t find what you need? Contact support.