Create a workflow for a household
POST/v1/households/:id/workflows
Creates a workflow for the household with the given ID from a workflow template of its linked CRM: an integer template in Wealthbox, a string template in Redtail. A CRM whose template is of the other form is skipped. With a Redtail template, send category. The response is 201 with data: null when no workflow was created, for example when the household is linked to neither Wealthbox nor Redtail. If your firm has no household with that ID, the response is 404.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 429
The workflow you created, or null.
id is not a whole number, or the request body is invalid, for example label or template is missing, or startsAt is not a date.
The access token is missing, invalid, or expired.
The access token does not have the write:household scope or the write:crm scope.
Your firm has no household with that ID.
Too many requests. Wait the number of seconds in the Retry-After-per-person header (script-audience tokens) or the Retry-After header (other requests) before you retry. See Rate limit.