Get a Job

GET

Get a bulk job

Path parameters

job_idstringRequired

A unique identifier representing the bulk job

Response

This endpoint returns an object.

jobobject

GET

1 curl https://api.courier.com/bulk/:job_id \
2      -H "Authorization: Bearer <authorizationToken>"

200Retrieved

1 {
2   "job": {
3     "definition": {
4       "message": {
5         "template": "string",
6         "data": {
7           "string": {}
8         },
9         "brand_id": "string",
10         "channels": {
11           "string": {
12             "brand_id": "string",
13             "providers": [
14               "string"
15             ],
16             "routing_method": "all",
17             "if": "string",
18             "timeouts": {
19               "provider": 0,
20               "channel": 0
21             },
22             "override": {
23               "string": {}
24             },
25             "metadata": {
26               "utm": {
27                 "source": "string",
28                 "medium": "string",
29                 "campaign": "string",
30                 "term": "string",
31                 "content": "string"
32               }
33             }
34           }
35         },
36         "context": {
37           "tenant_id": "string"
38         },
39         "metadata": {
40           "event": "string",
41           "tags": [
42             "string"
43           ],
44           "utm": {
45             "source": "string",
46             "medium": "string",
47             "campaign": "string",
48             "term": "string",
49             "content": "string"
50           },
51           "trace_id": "string"
52         },
53         "preferences": {
54           "subscription_topic_id": "string"
55         },
56         "providers": {
57           "string": {
58             "override": {
59               "string": {}
60             },
61             "if": "string",
62             "timeouts": 0,
63             "metadata": {
64               "utm": {
65                 "source": "string",
66                 "medium": "string",
67                 "campaign": "string",
68                 "term": "string",
69                 "content": "string"
70               }
71             }
72           }
73         },
74         "routing": {
75           "method": "all",
76           "channels": [
77             {
78               "channel": "string",
79               "config": {
80                 "string": {}
81               },
82               "method": "all",
83               "providers": {
84                 "string": {
85                   "override": {
86                     "string": {}
87                   },
88                   "if": "string",
89                   "timeouts": 0,
90                   "metadata": {
91                     "utm": {
92                       "source": "string",
93                       "medium": "string",
94                       "campaign": "string",
95                       "term": "string",
96                       "content": "string"
97                     }
98                   }
99                 }
100               },
101               "if": "string"
102             }
103           ]
104         },
105         "timeout": {
106           "provider": {
107             "string": 0
108           },
109           "channel": {
110             "string": 0
111           },
112           "message": 0,
113           "escalation": 0,
114           "criteria": "no-escalation"
115         },
116         "delay": {
117           "duration": 0
118         },
119         "expiry": {
120           "expires_at": "string",
121           "expires_in": "string"
122         }
123       },
124       "brand": "string",
125       "data": {
126         "string": {}
127       },
128       "event": "string",
129       "locale": {
130         "string": {}
131       },
132       "override": {}
133     },
134     "enqueued": 0,
135     "failures": 0,
136     "received": 0,
137     "status": "CREATED"
138   }
139 }

Built with

1	curl https://api.courier.com/bulk/:job_id \
2	-H "Authorization: Bearer <authorizationToken>"

1	{
2	"job": {
3	"definition": {
4	"message": {
5	"template": "string",
6	"data": {
7	"string": {}
8	},
9	"brand_id": "string",
10	"channels": {
11	"string": {
12	"brand_id": "string",
13	"providers": [
14	"string"
15	],
16	"routing_method": "all",
17	"if": "string",
18	"timeouts": {
19	"provider": 0,
20	"channel": 0
21	},
22	"override": {
23	"string": {}
24	},
25	"metadata": {
26	"utm": {
27	"source": "string",
28	"medium": "string",
29	"campaign": "string",
30	"term": "string",
31	"content": "string"
32	}
33	}
34	}
35	},
36	"context": {
37	"tenant_id": "string"
38	},
39	"metadata": {
40	"event": "string",
41	"tags": [
42	"string"
43	],
44	"utm": {
45	"source": "string",
46	"medium": "string",
47	"campaign": "string",
48	"term": "string",
49	"content": "string"
50	},
51	"trace_id": "string"
52	},
53	"preferences": {
54	"subscription_topic_id": "string"
55	},
56	"providers": {
57	"string": {
58	"override": {
59	"string": {}
60	},
61	"if": "string",
62	"timeouts": 0,
63	"metadata": {
64	"utm": {
65	"source": "string",
66	"medium": "string",
67	"campaign": "string",
68	"term": "string",
69	"content": "string"
70	}
71	}
72	}
73	},
74	"routing": {
75	"method": "all",
76	"channels": [
77	{
78	"channel": "string",
79	"config": {
80	"string": {}
81	},
82	"method": "all",
83	"providers": {
84	"string": {
85	"override": {
86	"string": {}
87	},
88	"if": "string",
89	"timeouts": 0,
90	"metadata": {
91	"utm": {
92	"source": "string",
93	"medium": "string",
94	"campaign": "string",
95	"term": "string",
96	"content": "string"
97	}
98	}
99	}
100	},
101	"if": "string"
102	}
103	]
104	},
105	"timeout": {
106	"provider": {
107	"string": 0
108	},
109	"channel": {
110	"string": 0
111	},
112	"message": 0,
113	"escalation": 0,
114	"criteria": "no-escalation"
115	},
116	"delay": {
117	"duration": 0
118	},
119	"expiry": {
120	"expires_at": "string",
121	"expires_in": "string"
122	}
123	},
124	"brand": "string",
125	"data": {
126	"string": {}
127	},
128	"event": "string",
129	"locale": {
130	"string": {}
131	},
132	"override": {}
133	},
134	"enqueued": 0,
135	"failures": 0,
136	"received": 0,
137	"status": "CREATED"
138	}
139	}