API Reference

Update organization configuration by external organization id

patch
https://api.joinpopp.com/v1/config/by-external-organization-id/

Creates or updates the configuration for the organization matching your own organization id, scoped to your organization group. Returns 409 if the external id matches more than one organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your own identifier for the organization, as set on externalOrganizationId

Body Params

Update Organization Configuration Request

string

A valid ID of an existing agent. Cannot be used together with agentName and agentTone.

string

Name of the agent. Must be provided together with agentTone. Cannot be used with agentId.

string
enum

Tone of the agent. Must be provided together with agentName. Cannot be used with agentId.

Allowed:
number
≥ 24

Time in hours before conversations auto-close

string

Message sent when the candidate is rejected

string

Message sent when the candidate is not interested

string

Shared configuration and context applied across all campaigns in the organization

templates
array of strings, unique

Array of template IDs

templates
protectedCharacteristics
object

Characteristics the search agent must refuse to search on. Merged onto the current settings, so you only need to send what you are changing. Send a characteristic as true to protect it again. Anything never set stays protected.

Responses

Updated 4 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?