Skip to main content

Credentials

Create API keys in Jobin integrations under Custom integration. Send the key in x-api-key and verify it with GET /auth/validate.

Complete actions in order

  1. Search or fetch the target contact.
  2. Request enrichment when required fields are missing.
  3. Check GET /contacts/{contactId} for those fields. Increase the time between checks and stop after a set waiting period.
  4. Assign the contact to a campaign to launch the configured sequence.
People Search, enrichment, and campaign assignment can spend credits or create background work. Check the result before retrying an interrupted request.

Handle errors and retries

Most errors return { code, error } with a message your assistant or tool can display. API key validation returns { valid: false, error }; endpoint rate-limit responses include retryAfterSeconds. A 202 response means Jobin queued the work. Check the relevant contact or operation afterward.

Rate limits

Each endpoint has a request limit. Authenticated endpoint budgets are shared by all API keys in the workgroup, and a general 1,000 requests per minute per source IP limit applies across endpoints. Action-specific limits apply alongside the authenticated baseline and general limit. Requests for different contact or campaign IDs share the same action’s limit. Read x-ratelimit-limit, x-ratelimit-remaining, and x-ratelimit-reset for the applicable budget. For 429 responses, wait for retry-after seconds and use exponential backoff for repeated retries.