Basically we have 4 states for a container, such asA Container has an attribute called state which defines the current state of your Container.
This attribute value has four possible values, they are: created, send, sent, completed
The Container respects the following lifecycle:
created => send => sent => [send or complete]
*The sent state may transition back to send if you want to resend that Container to it Recipient.
States
created
When you create a Container, the initial state is, created.send
After the state created, we have the state send, basically when you send a notification of this container, the state of container change fromcreated
tosend
.sent
If we can deliver your container with successfully or not to the client, the state change fromsend
tosent
.completed
Aftersent
, the the receiver probably will receive your container and if there’s a pull, push or docusign and he done with that, the container change fromsent
tocompleted
, other way the container change this state is the fieldexpires_at
is filled with a date and the date is bigger thanexpires_at
field, in this case the state will be fromsent
tocompleted
The Container was only created, it is unaccessable by everyone. Only you can add/edit/delete functionalities to this Container through API calls.send
A Container is marked as send when you request that Container to be sent through the API call to send the notification. The container will be queued for sending and, it will transition to another state as soon it is sent.sent
As soon the Container is sent successfully, the Container transition to a sent state. This state indicates the Container is available for your included Recipient(s) set at the time of creation and, it will be until you forcelly terminate the Container or the expiration times runs by.completed
This is the final state of a Container. When the expiration of a Container runs by or you forcelly terminates that Container, we mark that Container as completed. This means the Container is not accessible by anyone. You can only perform Container actions through API calls according to the Feature(s) that Container has. For instance, a Container may have a Pull Feature inside, at this point you would download any file associated with that Pull. When a Container get’s to this state, it also marks all Feature(s) it has as complete.