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

Built with

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

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