Turn on a job's forwarding address
Creates the job's address, or a fresh one after it was turned off. Repeating it while the address is on returns the current address and changes nothing. Send monthlyAnalysisCap to set the monthly limit in the same call; that needs a key created by an admin. A closed job cannot have an address.
Required scope: inbox:write.
Errors
- 400:
invalid_content_type,invalid_json,invalid_request,request_body_too_large,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope,permission_denied - 404:
resource_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
inbox_unavailable,maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>jobId*stringThe job's ID.
1 <= length <= 200application/json- body
monthlyAnalysisCap?integerThe most analyses this address may start per calendar month (UTC), 1 to 500. Each analysis spends credits as a report does, so this is the spend limit for the address. Changing it needs a key created by an admin.
1 <= value <= 500Success.
application/json- response
object*stringjobId*stringThe job this address feeds.
status*stringactive receives mail. off does not, and also describes a job that never had an address: address is null and monthlyAnalysisCap is the default.
"active""off"address*|The address members forward resumes to, or null while it is off.
previous*|The address before the last rotation, while it still accepts mail because the rotation asked for a grace period. Null otherwise.
monthlyAnalysisCap*integerThe most analyses this address starts per calendar month (UTC). The forward is the confirmation of the spend and this cap bounds it; there is no per-request maxCredits.
-9007199254740991 <= value <= 9007199254740991analysesThisMonth*integerAnalyses this address has started this UTC month.
-9007199254740991 <= value <= 9007199254740991waiting*Files from this address that are waiting, counted by the reason they wait (for example credits or the monthly cap).
updatedAt*stringdate-time# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X PUT "$PROBB_URL/api/v1/jobs/JOB_ID_VALUE/forwarding-address" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "monthlyAnalysisCap": 50}'{ "object": "forwarding_address", "jobId": "string", "status": "active", "address": "string", "previous": { "address": "string", "until": "2019-08-24T14:15:22Z" }, "monthlyAnalysisCap": -9007199254740991, "analysesThisMonth": -9007199254740991, "waiting": { "property1": -9007199254740991, "property2": -9007199254740991 }, "updatedAt": "2019-08-24T14:15:22Z"}